<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
<title>DefaultExpressionEngine xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../apidocs/org/apache/commons/configuration/tree/DefaultExpressionEngine.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * contributor license agreements.  See the NOTICE file distributed with</em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * this work for additional information regarding copyright ownership.</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * the License.  You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> *     <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> *</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment"> * See the License for the specific language governing permissions and</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment"> * limitations under the License.</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  <strong class="jxr_keyword">package</strong> org.apache.commons.configuration.tree;
<a class="jxr_linenumber" name="18" href="#18">18</a>  
<a class="jxr_linenumber" name="19" href="#19">19</a>  <strong class="jxr_keyword">import</strong> java.util.Collection;
<a class="jxr_linenumber" name="20" href="#20">20</a>  <strong class="jxr_keyword">import</strong> java.util.LinkedList;
<a class="jxr_linenumber" name="21" href="#21">21</a>  <strong class="jxr_keyword">import</strong> java.util.List;
<a class="jxr_linenumber" name="22" href="#22">22</a>  
<a class="jxr_linenumber" name="23" href="#23">23</a>  <strong class="jxr_keyword">import</strong> org.apache.commons.lang.StringUtils;
<a class="jxr_linenumber" name="24" href="#24">24</a>  
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_javadoccomment"> * A default implementation of the {@code ExpressionEngine} interface</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment"> * providing the &amp;quot;native&amp;quote; expression language for hierarchical</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment"> * configurations.</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * This class implements a rather simple expression language for navigating</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * through a hierarchy of configuration nodes. It supports the following</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * operations:</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * &lt;ul&gt;</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Navigating from a node to one of its children using the child node</em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> * delimiter, which is by the default a dot (&amp;quot;.&amp;quot;).&lt;/li&gt;</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;Navigating from a node to one of its attributes using the attribute node</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment"> * delimiter, which by default follows the XPATH like syntax</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment"> * &lt;code&gt;[@&amp;lt;attributeName&amp;gt;]&lt;/code&gt;.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment"> * &lt;li&gt;If there are multiple child or attribute nodes with the same name, a</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment"> * specific node can be selected using a numerical index. By default indices are</em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment"> * written in parenthesis.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment"> * &lt;/ul&gt;</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment"> * As an example consider the following XML document:</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment"> * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment"> *  &amp;lt;database&amp;gt;</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment"> *    &amp;lt;tables&amp;gt;</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment"> *      &amp;lt;table type=&amp;quot;system&amp;quot;&amp;gt;</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment"> *        &amp;lt;name&amp;gt;users&amp;lt;/name&amp;gt;</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment"> *        &amp;lt;fields&amp;gt;</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment"> *          &amp;lt;field&amp;gt;</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment"> *            &amp;lt;name&amp;gt;lid&amp;lt;/name&amp;gt;</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment"> *            &amp;lt;type&amp;gt;long&amp;lt;/name&amp;gt;</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment"> *          &amp;lt;/field&amp;gt;</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  <em class="jxr_javadoccomment"> *          &amp;lt;field&amp;gt;</em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_javadoccomment"> *            &amp;lt;name&amp;gt;usrName&amp;lt;/name&amp;gt;</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_javadoccomment"> *            &amp;lt;type&amp;gt;java.lang.String&amp;lt;/type&amp;gt;</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment"> *          &amp;lt;/field&amp;gt;</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment"> *         ...</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  <em class="jxr_javadoccomment"> *        &amp;lt;/fields&amp;gt;</em>
<a class="jxr_linenumber" name="68" href="#68">68</a>  <em class="jxr_javadoccomment"> *      &amp;lt;/table&amp;gt;</em>
<a class="jxr_linenumber" name="69" href="#69">69</a>  <em class="jxr_javadoccomment"> *      &amp;lt;table&amp;gt;</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment"> *        &amp;lt;name&amp;gt;documents&amp;lt;/name&amp;gt;</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment"> *        &amp;lt;fields&amp;gt;</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment"> *          &amp;lt;field&amp;gt;</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  <em class="jxr_javadoccomment"> *            &amp;lt;name&amp;gt;docid&amp;lt;/name&amp;gt;</em>
<a class="jxr_linenumber" name="74" href="#74">74</a>  <em class="jxr_javadoccomment"> *            &amp;lt;type&amp;gt;long&amp;lt;/type&amp;gt;</em>
<a class="jxr_linenumber" name="75" href="#75">75</a>  <em class="jxr_javadoccomment"> *          &amp;lt;/field&amp;gt;</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment"> *          ...</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment"> *        &amp;lt;/fields&amp;gt;</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  <em class="jxr_javadoccomment"> *      &amp;lt;/table&amp;gt;</em>
<a class="jxr_linenumber" name="79" href="#79">79</a>  <em class="jxr_javadoccomment"> *      ...</em>
<a class="jxr_linenumber" name="80" href="#80">80</a>  <em class="jxr_javadoccomment"> *    &amp;lt;/tables&amp;gt;</em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment"> *  &amp;lt;/database&amp;gt;</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment"> * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="85" href="#85">85</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="86" href="#86">86</a>  <em class="jxr_javadoccomment"> * If this document is parsed and stored in a hierarchical configuration object,</em>
<a class="jxr_linenumber" name="87" href="#87">87</a>  <em class="jxr_javadoccomment"> * for instance the key {@code tables.table(0).name} can be used to find</em>
<a class="jxr_linenumber" name="88" href="#88">88</a>  <em class="jxr_javadoccomment"> * out the name of the first table. In opposite {@code tables.table.name}</em>
<a class="jxr_linenumber" name="89" href="#89">89</a>  <em class="jxr_javadoccomment"> * would return a collection with the names of all available tables. Similarly</em>
<a class="jxr_linenumber" name="90" href="#90">90</a>  <em class="jxr_javadoccomment"> * the key {@code tables.table(1).fields.field.name} returns a collection</em>
<a class="jxr_linenumber" name="91" href="#91">91</a>  <em class="jxr_javadoccomment"> * with the names of all fields of the second table. If another index is added</em>
<a class="jxr_linenumber" name="92" href="#92">92</a>  <em class="jxr_javadoccomment"> * after the {@code field} element, a single field can be accessed:</em>
<a class="jxr_linenumber" name="93" href="#93">93</a>  <em class="jxr_javadoccomment"> * {@code tables.table(1).fields.field(0).name}. The key</em>
<a class="jxr_linenumber" name="94" href="#94">94</a>  <em class="jxr_javadoccomment"> * {@code tables.table(0)[@type]} would select the type attribute of the</em>
<a class="jxr_linenumber" name="95" href="#95">95</a>  <em class="jxr_javadoccomment"> * first table.</em>
<a class="jxr_linenumber" name="96" href="#96">96</a>  <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="97" href="#97">97</a>  <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a class="jxr_linenumber" name="98" href="#98">98</a>  <em class="jxr_javadoccomment"> * This example works with the default values for delimiters and index markers.</em>
<a class="jxr_linenumber" name="99" href="#99">99</a>  <em class="jxr_javadoccomment"> * It is also possible to set custom values for these properties so that you can</em>
<a class="jxr_linenumber" name="100" href="#100">100</a> <em class="jxr_javadoccomment"> * adapt a {@code DefaultExpressionEngine} to your personal needs.</em>
<a class="jxr_linenumber" name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em>
<a class="jxr_linenumber" name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @since 1.3</em>
<a class="jxr_linenumber" name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @author &lt;a</em>
<a class="jxr_linenumber" name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * href="<a href="http://commons.apache.org/configuration/team-list.html" target="alexandria_uri">http://commons.apache.org/configuration/team-list.html</a>"&gt;Commons</em>
<a class="jxr_linenumber" name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * Configuration team&lt;/a&gt;</em>
<a class="jxr_linenumber" name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * @version $Id: DefaultExpressionEngine.java 1301991 2012-03-17 20:18:02Z sebb $</em>
<a class="jxr_linenumber" name="108" href="#108">108</a> <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="109" href="#109">109</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/commons/configuration/tree/DefaultExpressionEngine.html">DefaultExpressionEngine</a> <strong class="jxr_keyword">implements</strong> <a href="../../../../../org/apache/commons/configuration/tree/ExpressionEngine.html">ExpressionEngine</a>
<a class="jxr_linenumber" name="110" href="#110">110</a> {
<a class="jxr_linenumber" name="111" href="#111">111</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default property delimiter. */</em>
<a class="jxr_linenumber" name="112" href="#112">112</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_PROPERTY_DELIMITER = <span class="jxr_string">"."</span>;
<a class="jxr_linenumber" name="113" href="#113">113</a> 
<a class="jxr_linenumber" name="114" href="#114">114</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default escaped property delimiter. */</em>
<a class="jxr_linenumber" name="115" href="#115">115</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ESCAPED_DELIMITER = DEFAULT_PROPERTY_DELIMITER
<a class="jxr_linenumber" name="116" href="#116">116</a>             + DEFAULT_PROPERTY_DELIMITER;
<a class="jxr_linenumber" name="117" href="#117">117</a> 
<a class="jxr_linenumber" name="118" href="#118">118</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default attribute start marker. */</em>
<a class="jxr_linenumber" name="119" href="#119">119</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ATTRIBUTE_START = <span class="jxr_string">"[@"</span>;
<a class="jxr_linenumber" name="120" href="#120">120</a> 
<a class="jxr_linenumber" name="121" href="#121">121</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default attribute end marker. */</em>
<a class="jxr_linenumber" name="122" href="#122">122</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_ATTRIBUTE_END = <span class="jxr_string">"]"</span>;
<a class="jxr_linenumber" name="123" href="#123">123</a> 
<a class="jxr_linenumber" name="124" href="#124">124</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default index start marker. */</em>
<a class="jxr_linenumber" name="125" href="#125">125</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_INDEX_START = <span class="jxr_string">"("</span>;
<a class="jxr_linenumber" name="126" href="#126">126</a> 
<a class="jxr_linenumber" name="127" href="#127">127</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Constant for the default index end marker. */</em>
<a class="jxr_linenumber" name="128" href="#128">128</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String DEFAULT_INDEX_END = <span class="jxr_string">")"</span>;
<a class="jxr_linenumber" name="129" href="#129">129</a> 
<a class="jxr_linenumber" name="130" href="#130">130</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the property delimiter. */</em>
<a class="jxr_linenumber" name="131" href="#131">131</a>     <strong class="jxr_keyword">private</strong> String propertyDelimiter = DEFAULT_PROPERTY_DELIMITER;
<a class="jxr_linenumber" name="132" href="#132">132</a> 
<a class="jxr_linenumber" name="133" href="#133">133</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the escaped property delimiter. */</em>
<a class="jxr_linenumber" name="134" href="#134">134</a>     <strong class="jxr_keyword">private</strong> String escapedDelimiter = DEFAULT_ESCAPED_DELIMITER;
<a class="jxr_linenumber" name="135" href="#135">135</a> 
<a class="jxr_linenumber" name="136" href="#136">136</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the attribute start marker. */</em>
<a class="jxr_linenumber" name="137" href="#137">137</a>     <strong class="jxr_keyword">private</strong> String attributeStart = DEFAULT_ATTRIBUTE_START;
<a class="jxr_linenumber" name="138" href="#138">138</a> 
<a class="jxr_linenumber" name="139" href="#139">139</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the attribute end marker. */</em>
<a class="jxr_linenumber" name="140" href="#140">140</a>     <strong class="jxr_keyword">private</strong> String attributeEnd = DEFAULT_ATTRIBUTE_END;
<a class="jxr_linenumber" name="141" href="#141">141</a> 
<a class="jxr_linenumber" name="142" href="#142">142</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Stores the index start marker. */</em>
<a class="jxr_linenumber" name="143" href="#143">143</a>     <strong class="jxr_keyword">private</strong> String indexStart = DEFAULT_INDEX_START;
<a class="jxr_linenumber" name="144" href="#144">144</a> 
<a class="jxr_linenumber" name="145" href="#145">145</a>     <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> stores the index end marker. */</em>
<a class="jxr_linenumber" name="146" href="#146">146</a>     <strong class="jxr_keyword">private</strong> String indexEnd = DEFAULT_INDEX_END;
<a class="jxr_linenumber" name="147" href="#147">147</a> 
<a class="jxr_linenumber" name="148" href="#148">148</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="149" href="#149">149</a> <em class="jxr_javadoccomment">     * Sets the attribute end marker.</em>
<a class="jxr_linenumber" name="150" href="#150">150</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="151" href="#151">151</a> <em class="jxr_javadoccomment">     * @return the attribute end marker</em>
<a class="jxr_linenumber" name="152" href="#152">152</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="153" href="#153">153</a>     <strong class="jxr_keyword">public</strong> String getAttributeEnd()
<a class="jxr_linenumber" name="154" href="#154">154</a>     {
<a class="jxr_linenumber" name="155" href="#155">155</a>         <strong class="jxr_keyword">return</strong> attributeEnd;
<a class="jxr_linenumber" name="156" href="#156">156</a>     }
<a class="jxr_linenumber" name="157" href="#157">157</a> 
<a class="jxr_linenumber" name="158" href="#158">158</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="159" href="#159">159</a> <em class="jxr_javadoccomment">     * Sets the attribute end marker.</em>
<a class="jxr_linenumber" name="160" href="#160">160</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="161" href="#161">161</a> <em class="jxr_javadoccomment">     * @param attributeEnd the attribute end marker; can be &lt;b&gt;null&lt;/b&gt; if no</em>
<a class="jxr_linenumber" name="162" href="#162">162</a> <em class="jxr_javadoccomment">     * end marker is needed</em>
<a class="jxr_linenumber" name="163" href="#163">163</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="164" href="#164">164</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAttributeEnd(String attributeEnd)
<a class="jxr_linenumber" name="165" href="#165">165</a>     {
<a class="jxr_linenumber" name="166" href="#166">166</a>         <strong class="jxr_keyword">this</strong>.attributeEnd = attributeEnd;
<a class="jxr_linenumber" name="167" href="#167">167</a>     }
<a class="jxr_linenumber" name="168" href="#168">168</a> 
<a class="jxr_linenumber" name="169" href="#169">169</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="170" href="#170">170</a> <em class="jxr_javadoccomment">     * Returns the attribute start marker.</em>
<a class="jxr_linenumber" name="171" href="#171">171</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="172" href="#172">172</a> <em class="jxr_javadoccomment">     * @return the attribute start marker</em>
<a class="jxr_linenumber" name="173" href="#173">173</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="174" href="#174">174</a>     <strong class="jxr_keyword">public</strong> String getAttributeStart()
<a class="jxr_linenumber" name="175" href="#175">175</a>     {
<a class="jxr_linenumber" name="176" href="#176">176</a>         <strong class="jxr_keyword">return</strong> attributeStart;
<a class="jxr_linenumber" name="177" href="#177">177</a>     }
<a class="jxr_linenumber" name="178" href="#178">178</a> 
<a class="jxr_linenumber" name="179" href="#179">179</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="180" href="#180">180</a> <em class="jxr_javadoccomment">     * Sets the attribute start marker. Attribute start and end marker are used</em>
<a class="jxr_linenumber" name="181" href="#181">181</a> <em class="jxr_javadoccomment">     * together to detect attributes in a property key.</em>
<a class="jxr_linenumber" name="182" href="#182">182</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="183" href="#183">183</a> <em class="jxr_javadoccomment">     * @param attributeStart the attribute start marker</em>
<a class="jxr_linenumber" name="184" href="#184">184</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="185" href="#185">185</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setAttributeStart(String attributeStart)
<a class="jxr_linenumber" name="186" href="#186">186</a>     {
<a class="jxr_linenumber" name="187" href="#187">187</a>         <strong class="jxr_keyword">this</strong>.attributeStart = attributeStart;
<a class="jxr_linenumber" name="188" href="#188">188</a>     }
<a class="jxr_linenumber" name="189" href="#189">189</a> 
<a class="jxr_linenumber" name="190" href="#190">190</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="191" href="#191">191</a> <em class="jxr_javadoccomment">     * Returns the escaped property delimiter string.</em>
<a class="jxr_linenumber" name="192" href="#192">192</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="193" href="#193">193</a> <em class="jxr_javadoccomment">     * @return the escaped property delimiter</em>
<a class="jxr_linenumber" name="194" href="#194">194</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="195" href="#195">195</a>     <strong class="jxr_keyword">public</strong> String getEscapedDelimiter()
<a class="jxr_linenumber" name="196" href="#196">196</a>     {
<a class="jxr_linenumber" name="197" href="#197">197</a>         <strong class="jxr_keyword">return</strong> escapedDelimiter;
<a class="jxr_linenumber" name="198" href="#198">198</a>     }
<a class="jxr_linenumber" name="199" href="#199">199</a> 
<a class="jxr_linenumber" name="200" href="#200">200</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="201" href="#201">201</a> <em class="jxr_javadoccomment">     * Sets the escaped property delimiter string. With this string a delimiter</em>
<a class="jxr_linenumber" name="202" href="#202">202</a> <em class="jxr_javadoccomment">     * that belongs to the key of a property can be escaped. If for instance</em>
<a class="jxr_linenumber" name="203" href="#203">203</a> <em class="jxr_javadoccomment">     * &amp;quot;.&amp;quot; is used as property delimiter, you can set the escaped</em>
<a class="jxr_linenumber" name="204" href="#204">204</a> <em class="jxr_javadoccomment">     * delimiter to &amp;quot;\.&amp;quot; and can then escape the delimiter with a back</em>
<a class="jxr_linenumber" name="205" href="#205">205</a> <em class="jxr_javadoccomment">     * slash.</em>
<a class="jxr_linenumber" name="206" href="#206">206</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="207" href="#207">207</a> <em class="jxr_javadoccomment">     * @param escapedDelimiter the escaped delimiter string</em>
<a class="jxr_linenumber" name="208" href="#208">208</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="209" href="#209">209</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setEscapedDelimiter(String escapedDelimiter)
<a class="jxr_linenumber" name="210" href="#210">210</a>     {
<a class="jxr_linenumber" name="211" href="#211">211</a>         <strong class="jxr_keyword">this</strong>.escapedDelimiter = escapedDelimiter;
<a class="jxr_linenumber" name="212" href="#212">212</a>     }
<a class="jxr_linenumber" name="213" href="#213">213</a> 
<a class="jxr_linenumber" name="214" href="#214">214</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="215" href="#215">215</a> <em class="jxr_javadoccomment">     * Returns the index end marker.</em>
<a class="jxr_linenumber" name="216" href="#216">216</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="217" href="#217">217</a> <em class="jxr_javadoccomment">     * @return the index end marker</em>
<a class="jxr_linenumber" name="218" href="#218">218</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="219" href="#219">219</a>     <strong class="jxr_keyword">public</strong> String getIndexEnd()
<a class="jxr_linenumber" name="220" href="#220">220</a>     {
<a class="jxr_linenumber" name="221" href="#221">221</a>         <strong class="jxr_keyword">return</strong> indexEnd;
<a class="jxr_linenumber" name="222" href="#222">222</a>     }
<a class="jxr_linenumber" name="223" href="#223">223</a> 
<a class="jxr_linenumber" name="224" href="#224">224</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="225" href="#225">225</a> <em class="jxr_javadoccomment">     * Sets the index end marker.</em>
<a class="jxr_linenumber" name="226" href="#226">226</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="227" href="#227">227</a> <em class="jxr_javadoccomment">     * @param indexEnd the index end marker</em>
<a class="jxr_linenumber" name="228" href="#228">228</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="229" href="#229">229</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIndexEnd(String indexEnd)
<a class="jxr_linenumber" name="230" href="#230">230</a>     {
<a class="jxr_linenumber" name="231" href="#231">231</a>         <strong class="jxr_keyword">this</strong>.indexEnd = indexEnd;
<a class="jxr_linenumber" name="232" href="#232">232</a>     }
<a class="jxr_linenumber" name="233" href="#233">233</a> 
<a class="jxr_linenumber" name="234" href="#234">234</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="235" href="#235">235</a> <em class="jxr_javadoccomment">     * Returns the index start marker.</em>
<a class="jxr_linenumber" name="236" href="#236">236</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="237" href="#237">237</a> <em class="jxr_javadoccomment">     * @return the index start marker</em>
<a class="jxr_linenumber" name="238" href="#238">238</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="239" href="#239">239</a>     <strong class="jxr_keyword">public</strong> String getIndexStart()
<a class="jxr_linenumber" name="240" href="#240">240</a>     {
<a class="jxr_linenumber" name="241" href="#241">241</a>         <strong class="jxr_keyword">return</strong> indexStart;
<a class="jxr_linenumber" name="242" href="#242">242</a>     }
<a class="jxr_linenumber" name="243" href="#243">243</a> 
<a class="jxr_linenumber" name="244" href="#244">244</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="245" href="#245">245</a> <em class="jxr_javadoccomment">     * Sets the index start marker. Index start and end marker are used together</em>
<a class="jxr_linenumber" name="246" href="#246">246</a> <em class="jxr_javadoccomment">     * to detect indices in a property key.</em>
<a class="jxr_linenumber" name="247" href="#247">247</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="248" href="#248">248</a> <em class="jxr_javadoccomment">     * @param indexStart the index start marker</em>
<a class="jxr_linenumber" name="249" href="#249">249</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="250" href="#250">250</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setIndexStart(String indexStart)
<a class="jxr_linenumber" name="251" href="#251">251</a>     {
<a class="jxr_linenumber" name="252" href="#252">252</a>         <strong class="jxr_keyword">this</strong>.indexStart = indexStart;
<a class="jxr_linenumber" name="253" href="#253">253</a>     }
<a class="jxr_linenumber" name="254" href="#254">254</a> 
<a class="jxr_linenumber" name="255" href="#255">255</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="256" href="#256">256</a> <em class="jxr_javadoccomment">     * Returns the property delimiter.</em>
<a class="jxr_linenumber" name="257" href="#257">257</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="258" href="#258">258</a> <em class="jxr_javadoccomment">     * @return the property delimiter</em>
<a class="jxr_linenumber" name="259" href="#259">259</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="260" href="#260">260</a>     <strong class="jxr_keyword">public</strong> String getPropertyDelimiter()
<a class="jxr_linenumber" name="261" href="#261">261</a>     {
<a class="jxr_linenumber" name="262" href="#262">262</a>         <strong class="jxr_keyword">return</strong> propertyDelimiter;
<a class="jxr_linenumber" name="263" href="#263">263</a>     }
<a class="jxr_linenumber" name="264" href="#264">264</a> 
<a class="jxr_linenumber" name="265" href="#265">265</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="266" href="#266">266</a> <em class="jxr_javadoccomment">     * Sets the property delimiter. This string is used to split the parts of a</em>
<a class="jxr_linenumber" name="267" href="#267">267</a> <em class="jxr_javadoccomment">     * property key.</em>
<a class="jxr_linenumber" name="268" href="#268">268</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="269" href="#269">269</a> <em class="jxr_javadoccomment">     * @param propertyDelimiter the property delimiter</em>
<a class="jxr_linenumber" name="270" href="#270">270</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="271" href="#271">271</a>     <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> setPropertyDelimiter(String propertyDelimiter)
<a class="jxr_linenumber" name="272" href="#272">272</a>     {
<a class="jxr_linenumber" name="273" href="#273">273</a>         <strong class="jxr_keyword">this</strong>.propertyDelimiter = propertyDelimiter;
<a class="jxr_linenumber" name="274" href="#274">274</a>     }
<a class="jxr_linenumber" name="275" href="#275">275</a> 
<a class="jxr_linenumber" name="276" href="#276">276</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="277" href="#277">277</a> <em class="jxr_javadoccomment">     * Evaluates the given key and returns all matching nodes. This method</em>
<a class="jxr_linenumber" name="278" href="#278">278</a> <em class="jxr_javadoccomment">     * supports the syntax as described in the class comment.</em>
<a class="jxr_linenumber" name="279" href="#279">279</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="280" href="#280">280</a> <em class="jxr_javadoccomment">     * @param root the root node</em>
<a class="jxr_linenumber" name="281" href="#281">281</a> <em class="jxr_javadoccomment">     * @param key the key</em>
<a class="jxr_linenumber" name="282" href="#282">282</a> <em class="jxr_javadoccomment">     * @return a list with the matching nodes</em>
<a class="jxr_linenumber" name="283" href="#283">283</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="284" href="#284">284</a>     <strong class="jxr_keyword">public</strong> List&lt;ConfigurationNode&gt; query(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> root, String key)
<a class="jxr_linenumber" name="285" href="#285">285</a>     {
<a class="jxr_linenumber" name="286" href="#286">286</a>         List&lt;ConfigurationNode&gt; nodes = <strong class="jxr_keyword">new</strong> LinkedList&lt;ConfigurationNode&gt;();
<a class="jxr_linenumber" name="287" href="#287">287</a>         findNodesForKey(<strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/configuration/tree/DefaultConfigurationKey.html">DefaultConfigurationKey</a>(<strong class="jxr_keyword">this</strong>, key).iterator(),
<a class="jxr_linenumber" name="288" href="#288">288</a>                 root, nodes);
<a class="jxr_linenumber" name="289" href="#289">289</a>         <strong class="jxr_keyword">return</strong> nodes;
<a class="jxr_linenumber" name="290" href="#290">290</a>     }
<a class="jxr_linenumber" name="291" href="#291">291</a> 
<a class="jxr_linenumber" name="292" href="#292">292</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="293" href="#293">293</a> <em class="jxr_javadoccomment">     * Determines the key of the passed in node. This implementation takes the</em>
<a class="jxr_linenumber" name="294" href="#294">294</a> <em class="jxr_javadoccomment">     * given parent key, adds a property delimiter, and then adds the node's</em>
<a class="jxr_linenumber" name="295" href="#295">295</a> <em class="jxr_javadoccomment">     * name. (For attribute nodes the attribute delimiters are used instead.)</em>
<a class="jxr_linenumber" name="296" href="#296">296</a> <em class="jxr_javadoccomment">     * The name of the root node is a blanc string. Note that no indices will be</em>
<a class="jxr_linenumber" name="297" href="#297">297</a> <em class="jxr_javadoccomment">     * returned.</em>
<a class="jxr_linenumber" name="298" href="#298">298</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="299" href="#299">299</a> <em class="jxr_javadoccomment">     * @param node the node whose key is to be determined</em>
<a class="jxr_linenumber" name="300" href="#300">300</a> <em class="jxr_javadoccomment">     * @param parentKey the key of this node's parent</em>
<a class="jxr_linenumber" name="301" href="#301">301</a> <em class="jxr_javadoccomment">     * @return the key for the given node</em>
<a class="jxr_linenumber" name="302" href="#302">302</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="303" href="#303">303</a>     <strong class="jxr_keyword">public</strong> String nodeKey(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> node, String parentKey)
<a class="jxr_linenumber" name="304" href="#304">304</a>     {
<a class="jxr_linenumber" name="305" href="#305">305</a>         <strong class="jxr_keyword">if</strong> (parentKey == <strong class="jxr_keyword">null</strong>)
<a class="jxr_linenumber" name="306" href="#306">306</a>         {
<a class="jxr_linenumber" name="307" href="#307">307</a>             <em class="jxr_comment">// this is the root node</em>
<a class="jxr_linenumber" name="308" href="#308">308</a>             <strong class="jxr_keyword">return</strong> StringUtils.EMPTY;
<a class="jxr_linenumber" name="309" href="#309">309</a>         }
<a class="jxr_linenumber" name="310" href="#310">310</a> 
<a class="jxr_linenumber" name="311" href="#311">311</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="312" href="#312">312</a>         {
<a class="jxr_linenumber" name="313" href="#313">313</a>             <a href="../../../../../org/apache/commons/configuration/tree/DefaultConfigurationKey.html">DefaultConfigurationKey</a> key = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/configuration/tree/DefaultConfigurationKey.html">DefaultConfigurationKey</a>(<strong class="jxr_keyword">this</strong>,
<a class="jxr_linenumber" name="314" href="#314">314</a>                     parentKey);
<a class="jxr_linenumber" name="315" href="#315">315</a>             <strong class="jxr_keyword">if</strong> (node.isAttribute())
<a class="jxr_linenumber" name="316" href="#316">316</a>             {
<a class="jxr_linenumber" name="317" href="#317">317</a>                 key.appendAttribute(node.getName());
<a class="jxr_linenumber" name="318" href="#318">318</a>             }
<a class="jxr_linenumber" name="319" href="#319">319</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="320" href="#320">320</a>             {
<a class="jxr_linenumber" name="321" href="#321">321</a>                 key.append(node.getName(), <strong class="jxr_keyword">true</strong>);
<a class="jxr_linenumber" name="322" href="#322">322</a>             }
<a class="jxr_linenumber" name="323" href="#323">323</a>             <strong class="jxr_keyword">return</strong> key.toString();
<a class="jxr_linenumber" name="324" href="#324">324</a>         }
<a class="jxr_linenumber" name="325" href="#325">325</a>     }
<a class="jxr_linenumber" name="326" href="#326">326</a> 
<a class="jxr_linenumber" name="327" href="#327">327</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="328" href="#328">328</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="329" href="#329">329</a> <em class="jxr_javadoccomment">     * Prepares Adding the property with the specified key.</em>
<a class="jxr_linenumber" name="330" href="#330">330</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="331" href="#331">331</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="332" href="#332">332</a> <em class="jxr_javadoccomment">     * To be able to deal with the structure supported by hierarchical</em>
<a class="jxr_linenumber" name="333" href="#333">333</a> <em class="jxr_javadoccomment">     * configuration implementations the passed in key is of importance,</em>
<a class="jxr_linenumber" name="334" href="#334">334</a> <em class="jxr_javadoccomment">     * especially the indices it might contain. The following example should</em>
<a class="jxr_linenumber" name="335" href="#335">335</a> <em class="jxr_javadoccomment">     * clarify this: Suppose the actual node structure looks like the</em>
<a class="jxr_linenumber" name="336" href="#336">336</a> <em class="jxr_javadoccomment">     * following:</em>
<a class="jxr_linenumber" name="337" href="#337">337</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="338" href="#338">338</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="339" href="#339">339</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="340" href="#340">340</a> <em class="jxr_javadoccomment">     *  tables</em>
<a class="jxr_linenumber" name="341" href="#341">341</a> <em class="jxr_javadoccomment">     *     +-- table</em>
<a class="jxr_linenumber" name="342" href="#342">342</a> <em class="jxr_javadoccomment">     *             +-- name = user</em>
<a class="jxr_linenumber" name="343" href="#343">343</a> <em class="jxr_javadoccomment">     *             +-- fields</em>
<a class="jxr_linenumber" name="344" href="#344">344</a> <em class="jxr_javadoccomment">     *                     +-- field</em>
<a class="jxr_linenumber" name="345" href="#345">345</a> <em class="jxr_javadoccomment">     *                             +-- name = uid</em>
<a class="jxr_linenumber" name="346" href="#346">346</a> <em class="jxr_javadoccomment">     *                     +-- field</em>
<a class="jxr_linenumber" name="347" href="#347">347</a> <em class="jxr_javadoccomment">     *                             +-- name = firstName</em>
<a class="jxr_linenumber" name="348" href="#348">348</a> <em class="jxr_javadoccomment">     *                     ...</em>
<a class="jxr_linenumber" name="349" href="#349">349</a> <em class="jxr_javadoccomment">     *     +-- table</em>
<a class="jxr_linenumber" name="350" href="#350">350</a> <em class="jxr_javadoccomment">     *             +-- name = documents</em>
<a class="jxr_linenumber" name="351" href="#351">351</a> <em class="jxr_javadoccomment">     *             +-- fields</em>
<a class="jxr_linenumber" name="352" href="#352">352</a> <em class="jxr_javadoccomment">     *                    ...</em>
<a class="jxr_linenumber" name="353" href="#353">353</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="354" href="#354">354</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="355" href="#355">355</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="356" href="#356">356</a> <em class="jxr_javadoccomment">     * In this example a database structure is defined, e.g. all fields of the</em>
<a class="jxr_linenumber" name="357" href="#357">357</a> <em class="jxr_javadoccomment">     * first table could be accessed using the key</em>
<a class="jxr_linenumber" name="358" href="#358">358</a> <em class="jxr_javadoccomment">     * {@code tables.table(0).fields.field.name}. If now properties are</em>
<a class="jxr_linenumber" name="359" href="#359">359</a> <em class="jxr_javadoccomment">     * to be added, it must be exactly specified at which position in the</em>
<a class="jxr_linenumber" name="360" href="#360">360</a> <em class="jxr_javadoccomment">     * hierarchy the new property is to be inserted. So to add a new field name</em>
<a class="jxr_linenumber" name="361" href="#361">361</a> <em class="jxr_javadoccomment">     * to a table it is not enough to say just</em>
<a class="jxr_linenumber" name="362" href="#362">362</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="363" href="#363">363</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="364" href="#364">364</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="365" href="#365">365</a> <em class="jxr_javadoccomment">     * config.addProperty(&amp;quot;tables.table.fields.field.name&amp;quot;, &amp;quot;newField&amp;quot;);</em>
<a class="jxr_linenumber" name="366" href="#366">366</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="367" href="#367">367</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="368" href="#368">368</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="369" href="#369">369</a> <em class="jxr_javadoccomment">     * The statement given above contains some ambiguity. For instance it is not</em>
<a class="jxr_linenumber" name="370" href="#370">370</a> <em class="jxr_javadoccomment">     * clear, to which table the new field should be added. If this method finds</em>
<a class="jxr_linenumber" name="371" href="#371">371</a> <em class="jxr_javadoccomment">     * such an ambiguity, it is resolved by following the last valid path. Here</em>
<a class="jxr_linenumber" name="372" href="#372">372</a> <em class="jxr_javadoccomment">     * this would be the last table. The same is true for the {@code field};</em>
<a class="jxr_linenumber" name="373" href="#373">373</a> <em class="jxr_javadoccomment">     * because there are multiple fields and no explicit index is provided, a</em>
<a class="jxr_linenumber" name="374" href="#374">374</a> <em class="jxr_javadoccomment">     * new {@code name} property would be added to the last field - which</em>
<a class="jxr_linenumber" name="375" href="#375">375</a> <em class="jxr_javadoccomment">     * is probably not what was desired.</em>
<a class="jxr_linenumber" name="376" href="#376">376</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="377" href="#377">377</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="378" href="#378">378</a> <em class="jxr_javadoccomment">     * To make things clear explicit indices should be provided whenever</em>
<a class="jxr_linenumber" name="379" href="#379">379</a> <em class="jxr_javadoccomment">     * possible. In the example above the exact table could be specified by</em>
<a class="jxr_linenumber" name="380" href="#380">380</a> <em class="jxr_javadoccomment">     * providing an index for the {@code table} element as in</em>
<a class="jxr_linenumber" name="381" href="#381">381</a> <em class="jxr_javadoccomment">     * {@code tables.table(1).fields}. By specifying an index it can</em>
<a class="jxr_linenumber" name="382" href="#382">382</a> <em class="jxr_javadoccomment">     * also be expressed that at a given position in the configuration tree a</em>
<a class="jxr_linenumber" name="383" href="#383">383</a> <em class="jxr_javadoccomment">     * new branch should be added. In the example above we did not want to add</em>
<a class="jxr_linenumber" name="384" href="#384">384</a> <em class="jxr_javadoccomment">     * an additional {@code name} element to the last field of the table,</em>
<a class="jxr_linenumber" name="385" href="#385">385</a> <em class="jxr_javadoccomment">     * but we want a complete new {@code field} element. This can be</em>
<a class="jxr_linenumber" name="386" href="#386">386</a> <em class="jxr_javadoccomment">     * achieved by specifying an invalid index (like -1) after the element where</em>
<a class="jxr_linenumber" name="387" href="#387">387</a> <em class="jxr_javadoccomment">     * a new branch should be created. Given this our example would run:</em>
<a class="jxr_linenumber" name="388" href="#388">388</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="389" href="#389">389</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="390" href="#390">390</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="391" href="#391">391</a> <em class="jxr_javadoccomment">     * config.addProperty(&amp;quot;tables.table(1).fields.field(-1).name&amp;quot;, &amp;quot;newField&amp;quot;);</em>
<a class="jxr_linenumber" name="392" href="#392">392</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="393" href="#393">393</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="394" href="#394">394</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="395" href="#395">395</a> <em class="jxr_javadoccomment">     * With this notation it is possible to add new branches everywhere. We</em>
<a class="jxr_linenumber" name="396" href="#396">396</a> <em class="jxr_javadoccomment">     * could for instance create a new {@code table} element by</em>
<a class="jxr_linenumber" name="397" href="#397">397</a> <em class="jxr_javadoccomment">     * specifying</em>
<a class="jxr_linenumber" name="398" href="#398">398</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="399" href="#399">399</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="400" href="#400">400</a> <em class="jxr_javadoccomment">     * &lt;pre&gt;</em>
<a class="jxr_linenumber" name="401" href="#401">401</a> <em class="jxr_javadoccomment">     * config.addProperty(&amp;quot;tables.table(-1).fields.field.name&amp;quot;, &amp;quot;newField2&amp;quot;);</em>
<a class="jxr_linenumber" name="402" href="#402">402</a> <em class="jxr_javadoccomment">     * &lt;/pre&gt;</em>
<a class="jxr_linenumber" name="403" href="#403">403</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="404" href="#404">404</a> <em class="jxr_javadoccomment">     * &lt;p&gt;</em>
<a class="jxr_linenumber" name="405" href="#405">405</a> <em class="jxr_javadoccomment">     * (Note that because after the {@code table} element a new branch is</em>
<a class="jxr_linenumber" name="406" href="#406">406</a> <em class="jxr_javadoccomment">     * created indices in following elements are not relevant; the branch is new</em>
<a class="jxr_linenumber" name="407" href="#407">407</a> <em class="jxr_javadoccomment">     * so there cannot be any ambiguities.)</em>
<a class="jxr_linenumber" name="408" href="#408">408</a> <em class="jxr_javadoccomment">     * &lt;/p&gt;</em>
<a class="jxr_linenumber" name="409" href="#409">409</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="410" href="#410">410</a> <em class="jxr_javadoccomment">     * @param root the root node of the nodes hierarchy</em>
<a class="jxr_linenumber" name="411" href="#411">411</a> <em class="jxr_javadoccomment">     * @param key the key of the new property</em>
<a class="jxr_linenumber" name="412" href="#412">412</a> <em class="jxr_javadoccomment">     * @return a data object with information needed for the add operation</em>
<a class="jxr_linenumber" name="413" href="#413">413</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="414" href="#414">414</a>     <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a> prepareAdd(<a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> root, String key)
<a class="jxr_linenumber" name="415" href="#415">415</a>     {
<a class="jxr_linenumber" name="416" href="#416">416</a>         DefaultConfigurationKey.KeyIterator it = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/configuration/tree/DefaultConfigurationKey.html">DefaultConfigurationKey</a>(
<a class="jxr_linenumber" name="417" href="#417">417</a>                 <strong class="jxr_keyword">this</strong>, key).iterator();
<a class="jxr_linenumber" name="418" href="#418">418</a>         <strong class="jxr_keyword">if</strong> (!it.hasNext())
<a class="jxr_linenumber" name="419" href="#419">419</a>         {
<a class="jxr_linenumber" name="420" href="#420">420</a>             <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a class="jxr_linenumber" name="421" href="#421">421</a>                     <span class="jxr_string">"Key for add operation must be defined!"</span>);
<a class="jxr_linenumber" name="422" href="#422">422</a>         }
<a class="jxr_linenumber" name="423" href="#423">423</a> 
<a class="jxr_linenumber" name="424" href="#424">424</a>         <a href="../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a> result = <strong class="jxr_keyword">new</strong> <a href="../../../../../org/apache/commons/configuration/tree/NodeAddData.html">NodeAddData</a>();
<a class="jxr_linenumber" name="425" href="#425">425</a>         result.setParent(findLastPathNode(it, root));
<a class="jxr_linenumber" name="426" href="#426">426</a> 
<a class="jxr_linenumber" name="427" href="#427">427</a>         <strong class="jxr_keyword">while</strong> (it.hasNext())
<a class="jxr_linenumber" name="428" href="#428">428</a>         {
<a class="jxr_linenumber" name="429" href="#429">429</a>             <strong class="jxr_keyword">if</strong> (!it.isPropertyKey())
<a class="jxr_linenumber" name="430" href="#430">430</a>             {
<a class="jxr_linenumber" name="431" href="#431">431</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a class="jxr_linenumber" name="432" href="#432">432</a>                         <span class="jxr_string">"Invalid key for add operation: "</span> + key
<a class="jxr_linenumber" name="433" href="#433">433</a>                                 + <span class="jxr_string">" (Attribute key in the middle.)"</span>);
<a class="jxr_linenumber" name="434" href="#434">434</a>             }
<a class="jxr_linenumber" name="435" href="#435">435</a>             result.addPathNode(it.currentKey());
<a class="jxr_linenumber" name="436" href="#436">436</a>             it.next();
<a class="jxr_linenumber" name="437" href="#437">437</a>         }
<a class="jxr_linenumber" name="438" href="#438">438</a> 
<a class="jxr_linenumber" name="439" href="#439">439</a>         result.setNewNodeName(it.currentKey());
<a class="jxr_linenumber" name="440" href="#440">440</a>         result.setAttribute(!it.isPropertyKey());
<a class="jxr_linenumber" name="441" href="#441">441</a>         <strong class="jxr_keyword">return</strong> result;
<a class="jxr_linenumber" name="442" href="#442">442</a>     }
<a class="jxr_linenumber" name="443" href="#443">443</a> 
<a class="jxr_linenumber" name="444" href="#444">444</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="445" href="#445">445</a> <em class="jxr_javadoccomment">     * Recursive helper method for evaluating a key. This method processes all</em>
<a class="jxr_linenumber" name="446" href="#446">446</a> <em class="jxr_javadoccomment">     * facets of a configuration key, traverses the tree of properties and</em>
<a class="jxr_linenumber" name="447" href="#447">447</a> <em class="jxr_javadoccomment">     * fetches the the nodes of all matching properties.</em>
<a class="jxr_linenumber" name="448" href="#448">448</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="449" href="#449">449</a> <em class="jxr_javadoccomment">     * @param keyPart the configuration key iterator</em>
<a class="jxr_linenumber" name="450" href="#450">450</a> <em class="jxr_javadoccomment">     * @param node the actual node</em>
<a class="jxr_linenumber" name="451" href="#451">451</a> <em class="jxr_javadoccomment">     * @param nodes here the found nodes are stored</em>
<a class="jxr_linenumber" name="452" href="#452">452</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="453" href="#453">453</a>     <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> findNodesForKey(DefaultConfigurationKey.KeyIterator keyPart,
<a class="jxr_linenumber" name="454" href="#454">454</a>             <a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> node, Collection&lt;ConfigurationNode&gt; nodes)
<a class="jxr_linenumber" name="455" href="#455">455</a>     {
<a class="jxr_linenumber" name="456" href="#456">456</a>         <strong class="jxr_keyword">if</strong> (!keyPart.hasNext())
<a class="jxr_linenumber" name="457" href="#457">457</a>         {
<a class="jxr_linenumber" name="458" href="#458">458</a>             nodes.add(node);
<a class="jxr_linenumber" name="459" href="#459">459</a>         }
<a class="jxr_linenumber" name="460" href="#460">460</a> 
<a class="jxr_linenumber" name="461" href="#461">461</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="462" href="#462">462</a>         {
<a class="jxr_linenumber" name="463" href="#463">463</a>             String key = keyPart.nextKey(false);
<a class="jxr_linenumber" name="464" href="#464">464</a>             <strong class="jxr_keyword">if</strong> (keyPart.isPropertyKey())
<a class="jxr_linenumber" name="465" href="#465">465</a>             {
<a class="jxr_linenumber" name="466" href="#466">466</a>                 processSubNodes(keyPart, node.getChildren(key), nodes);
<a class="jxr_linenumber" name="467" href="#467">467</a>             }
<a class="jxr_linenumber" name="468" href="#468">468</a>             <strong class="jxr_keyword">if</strong> (keyPart.isAttribute())
<a class="jxr_linenumber" name="469" href="#469">469</a>             {
<a class="jxr_linenumber" name="470" href="#470">470</a>                 processSubNodes(keyPart, node.getAttributes(key), nodes);
<a class="jxr_linenumber" name="471" href="#471">471</a>             }
<a class="jxr_linenumber" name="472" href="#472">472</a>         }
<a class="jxr_linenumber" name="473" href="#473">473</a>     }
<a class="jxr_linenumber" name="474" href="#474">474</a> 
<a class="jxr_linenumber" name="475" href="#475">475</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="476" href="#476">476</a> <em class="jxr_javadoccomment">     * Finds the last existing node for an add operation. This method traverses</em>
<a class="jxr_linenumber" name="477" href="#477">477</a> <em class="jxr_javadoccomment">     * the configuration node tree along the specified key. The last existing</em>
<a class="jxr_linenumber" name="478" href="#478">478</a> <em class="jxr_javadoccomment">     * node on this path is returned.</em>
<a class="jxr_linenumber" name="479" href="#479">479</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="480" href="#480">480</a> <em class="jxr_javadoccomment">     * @param keyIt the key iterator</em>
<a class="jxr_linenumber" name="481" href="#481">481</a> <em class="jxr_javadoccomment">     * @param node the actual node</em>
<a class="jxr_linenumber" name="482" href="#482">482</a> <em class="jxr_javadoccomment">     * @return the last existing node on the given path</em>
<a class="jxr_linenumber" name="483" href="#483">483</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="484" href="#484">484</a>     <strong class="jxr_keyword">protected</strong> <a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> findLastPathNode(
<a class="jxr_linenumber" name="485" href="#485">485</a>             DefaultConfigurationKey.KeyIterator keyIt, <a href="../../../../../org/apache/commons/configuration/tree/ConfigurationNode.html">ConfigurationNode</a> node)
<a class="jxr_linenumber" name="486" href="#486">486</a>     {
<a class="jxr_linenumber" name="487" href="#487">487</a>         String keyPart = keyIt.nextKey(false);
<a class="jxr_linenumber" name="488" href="#488">488</a> 
<a class="jxr_linenumber" name="489" href="#489">489</a>         <strong class="jxr_keyword">if</strong> (keyIt.hasNext())
<a class="jxr_linenumber" name="490" href="#490">490</a>         {
<a class="jxr_linenumber" name="491" href="#491">491</a>             <strong class="jxr_keyword">if</strong> (!keyIt.isPropertyKey())
<a class="jxr_linenumber" name="492" href="#492">492</a>             {
<a class="jxr_linenumber" name="493" href="#493">493</a>                 <em class="jxr_comment">// Attribute keys can only appear as last elements of the path</em>
<a class="jxr_linenumber" name="494" href="#494">494</a>                 <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a class="jxr_linenumber" name="495" href="#495">495</a>                         <span class="jxr_string">"Invalid path for add operation: "</span>
<a class="jxr_linenumber" name="496" href="#496">496</a>                                 + <span class="jxr_string">"Attribute key in the middle!"</span>);
<a class="jxr_linenumber" name="497" href="#497">497</a>             }
<a class="jxr_linenumber" name="498" href="#498">498</a>             <strong class="jxr_keyword">int</strong> idx = keyIt.hasIndex() ? keyIt.getIndex() : node
<a class="jxr_linenumber" name="499" href="#499">499</a>                     .getChildrenCount(keyPart) - 1;
<a class="jxr_linenumber" name="500" href="#500">500</a>             <strong class="jxr_keyword">if</strong> (idx &lt; 0 || idx &gt;= node.getChildrenCount(keyPart))
<a class="jxr_linenumber" name="501" href="#501">501</a>             {
<a class="jxr_linenumber" name="502" href="#502">502</a>                 <strong class="jxr_keyword">return</strong> node;
<a class="jxr_linenumber" name="503" href="#503">503</a>             }
<a class="jxr_linenumber" name="504" href="#504">504</a>             <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="505" href="#505">505</a>             {
<a class="jxr_linenumber" name="506" href="#506">506</a>                 <strong class="jxr_keyword">return</strong> findLastPathNode(keyIt, node.getChildren(keyPart).get(idx));
<a class="jxr_linenumber" name="507" href="#507">507</a>             }
<a class="jxr_linenumber" name="508" href="#508">508</a>         }
<a class="jxr_linenumber" name="509" href="#509">509</a> 
<a class="jxr_linenumber" name="510" href="#510">510</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="511" href="#511">511</a>         {
<a class="jxr_linenumber" name="512" href="#512">512</a>             <strong class="jxr_keyword">return</strong> node;
<a class="jxr_linenumber" name="513" href="#513">513</a>         }
<a class="jxr_linenumber" name="514" href="#514">514</a>     }
<a class="jxr_linenumber" name="515" href="#515">515</a> 
<a class="jxr_linenumber" name="516" href="#516">516</a>     <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="517" href="#517">517</a> <em class="jxr_javadoccomment">     * Called by {@code findNodesForKey()} to process the sub nodes of</em>
<a class="jxr_linenumber" name="518" href="#518">518</a> <em class="jxr_javadoccomment">     * the current node depending on the type of the current key part (children,</em>
<a class="jxr_linenumber" name="519" href="#519">519</a> <em class="jxr_javadoccomment">     * attributes, or both).</em>
<a class="jxr_linenumber" name="520" href="#520">520</a> <em class="jxr_javadoccomment">     *</em>
<a class="jxr_linenumber" name="521" href="#521">521</a> <em class="jxr_javadoccomment">     * @param keyPart the key part</em>
<a class="jxr_linenumber" name="522" href="#522">522</a> <em class="jxr_javadoccomment">     * @param subNodes a list with the sub nodes to process</em>
<a class="jxr_linenumber" name="523" href="#523">523</a> <em class="jxr_javadoccomment">     * @param nodes the target collection</em>
<a class="jxr_linenumber" name="524" href="#524">524</a> <em class="jxr_javadoccomment">     */</em>
<a class="jxr_linenumber" name="525" href="#525">525</a>     <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> processSubNodes(DefaultConfigurationKey.KeyIterator keyPart,
<a class="jxr_linenumber" name="526" href="#526">526</a>             List&lt;ConfigurationNode&gt; subNodes, Collection&lt;ConfigurationNode&gt; nodes)
<a class="jxr_linenumber" name="527" href="#527">527</a>     {
<a class="jxr_linenumber" name="528" href="#528">528</a>         <strong class="jxr_keyword">if</strong> (keyPart.hasIndex())
<a class="jxr_linenumber" name="529" href="#529">529</a>         {
<a class="jxr_linenumber" name="530" href="#530">530</a>             <strong class="jxr_keyword">if</strong> (keyPart.getIndex() &gt;= 0 &amp;&amp; keyPart.getIndex() &lt; subNodes.size())
<a class="jxr_linenumber" name="531" href="#531">531</a>             {
<a class="jxr_linenumber" name="532" href="#532">532</a>                 findNodesForKey((DefaultConfigurationKey.KeyIterator) keyPart
<a class="jxr_linenumber" name="533" href="#533">533</a>                         .clone(), subNodes.get(keyPart.getIndex()), nodes);
<a class="jxr_linenumber" name="534" href="#534">534</a>             }
<a class="jxr_linenumber" name="535" href="#535">535</a>         }
<a class="jxr_linenumber" name="536" href="#536">536</a>         <strong class="jxr_keyword">else</strong>
<a class="jxr_linenumber" name="537" href="#537">537</a>         {
<a class="jxr_linenumber" name="538" href="#538">538</a>             <strong class="jxr_keyword">for</strong> (ConfigurationNode node : subNodes)
<a class="jxr_linenumber" name="539" href="#539">539</a>             {
<a class="jxr_linenumber" name="540" href="#540">540</a>                 findNodesForKey((DefaultConfigurationKey.KeyIterator) keyPart
<a class="jxr_linenumber" name="541" href="#541">541</a>                         .clone(), node, nodes);
<a class="jxr_linenumber" name="542" href="#542">542</a>             }
<a class="jxr_linenumber" name="543" href="#543">543</a>         }
<a class="jxr_linenumber" name="544" href="#544">544</a>     }
<a class="jxr_linenumber" name="545" href="#545">545</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

